Protecting Data in Motion
APIgator Overviewâ
APIgator protects data in motion. It embeds directly into the systems, or any Gateway, facilitating the movement of data, capable of protecting all data in motion. This includes both data flowing through APIs (JSON and XML format) as well as streaming data (Kafka, Solace, and others).
To access APIgator, navigate to the left menu bar and click âAPIgatorâ' from here you are able to access the API configuration.
API Configuration
They are XML and JSON payloads through which you test and see the result of the data that the user wants to protect.
To access APIgator, navigate to the left menu bar and click âAPIgatorâ' and then âAPI Configurationâ from here you are able to add, edit and delete API configurations.
View Existing API Configuration
Once a manifest has been created you can then view the manifest with all the details available to see.
To view an API configuration, navigate to the chosen API configuration you would like to view, and click on the 'pencil' icon.
From here you can view the payload by clicking the âView Sample Payloadâ button. You are also able to see the HTML tree from the sample payload and the selected attributes from that HTML tree.
Edit Existing API Configuration
To edit an API Configuration, navigate to the pencil icon next to the chosen API.
From here you can edit the fields shown in the API Configuration.
Add new APIâ
To add an API navigate to the â+â button at the top of the API configuration page.
To add an API fill in the following fields:
Name: Name of manifest
Active: Toggle box to indicate whether or not it is active
Sample Payload: Button to create Sample Payload
Create Sample Payload
When a sample payload is created. You can click the checkboxes of the attribute to protect. This will set the attribute to be anonymised going forward. A modal will appear to determine what type of attribute the data is and if it is linked to a data asset map it to the subject entity identifier. This tags the data with what the data is (like a data dictionary) and who it belongs to.
To create a sample payload, navigate to the Sample Payload section when adding an API and click on the create button
HTML Tree
When a sample payload has been added, edited and saved it will render a HTML that matches the structure of the sample payload that has been added. The tree has nodes which can be selected, when a node is selected it is reflected below in a table called selected attributes.
Selected Attributes Table
This selected attribute table shows another way to display the attributes selected for ease of use.
The first column âAttribute Nameâ also shows the JSON path expression to identify that particular attribute. It is a unique path to be able to protect the information. The second column âAttribute Typeâ allows you to name the attribute with lookup from the available attribute types.
Add Filter
Adding an additional filter to an attribute is to add any additional conditional expressions. With adding a filter, you are able to select the element name, then choose the condition and the value.
To navigate to the page, click the add filter next to the attribute you want to add conditional expressions to. Once you have created the filter to submit click the âSubmitâ button.
When adding a filter, you can add more than one by clicking the âAdd New Conditionâ.
Subject Entity ID
The third column âSubject Entitiesâ. Which displays a drop-down menu when an attribute has been starred as a âSubject Entity IDâ. It shows a toggle box with the name âShow Subject Entity Flagsâ when this toggle box is turned on, next to the attributes a star option will appear. From here you can select what attributes you want to star as Subject Entity ID. The starred attributes will appear in the drop-down menu in Subject Entity. This is to show if there are any unique identifiers associated with the payload. For example, if someone exercises the right to be forgotten we can uniquely identify that record we can support that use case.
Once all the steps have been completed, you can then create the manifest, by clicking the âCreate Manifestâ button at the bottom.
Testing Outputsâ
To test an output to define how we are going to execute this job, and see if you can access the information within the output. Click the âTest Outputâ button; Which will bring you to the 'Test Output' page:
From here you can complete the following fields to test the output of the Manifest.
Test Output - When 'Run as User' is deselected:
Run as User: Toggle box to indicate whether to run as user
Internal or External sharing? Drop down box to indicate whether this is for external or internal sharing
How do you want to protect the data? Drop down box to indicate how you want to protect the data
Purpose of Use: Drop down box to indicate the purpose of use
Apply Localisation: Toggle box to indicate whether to apply localisation or not
Owning Country: Text box to enter the country owning the maifest
Requesting Country: The country requesting the data
Protect NULL Values: Toggle box to indicated whether or not to protect NULL values
Use Restricted Text: Toggle box to indicate whether or not to have restricted text
Restricted Text: The restricted text used to show what is restricted
Claim Key Value Pair: The claim key value pair that you want to --------
Sample Payload: XML or JSON payload added to the API Configuration updated when the test has been run.
Test Output - When 'Run as User' is selected:
Run as User: Toggle box to indicate whether to run as user
Username: The username of the user who will be running the test
Internal or External sharing? Drop down box to indicate whether this is for external or internal sharing
How do you want to protect the data? Drop down box to indicate how you want to protect the data
Purpose of Use: Drop down box to indicate the purpose of use
Apply Localisation: Toggle box to indicate whether to apply localisation or not
Owning Country: Text box to enter the country owning the maifest
Requesting Country: The country requesting the data
Protect NULL Values: Toggle box to indicated whether or not to protect NULL values
Use Restricted Text: Toggle box to indicate whether or not to have restricted text
Restricted Text: The restricted text used to show what is restricted
Claim Key Value Pair: The claim key value pair that you want to --------
Sample Payload: XML or JSON payload added to the API Configuration updated when the test has been run.
Once you have completed the following fields you can either test, reset, reset payload or close. To do any one of these click the matching button.
When you click the âTestâ button: The sample payload section will update matching the test that has been run.
When you click the âResetâ button: The fields will reset to their original values.
When you click the âReset Payloadâ button: The payload will reset to its original values.